home *** CD-ROM | disk | FTP | other *** search
/ FM Towns: Free Software Collection 4 / FM Towns Free Software Collection 4 - Disc 1.iso / msdos / ish / eish.man < prev    next >
Text File  |  1991-10-18  |  39KB  |  1,101 lines
  1.  
  2.  
  3.         How to use "ish file converter (Ver. 2.03)"
  4.  
  5.  
  6.  
  7. 0. Introduction
  8.  
  9.     This document includes the following chapters.
  10.  
  11.      0. Introduction
  12.      1. What is "ish file converter"
  13.      2. Quick reference to use ish file converter (restore files)
  14.      3. Usage of ish file converter
  15.      4. Switch summary
  16.      5. About an option file
  17.      6. About a multiple volume format
  18.      7. Set the timezone
  19.      8. Caution when aborting ish file converter
  20.      9. Message summary
  21.     10. Examples to use
  22.     11. Copyrights and permission
  23.     12. Special thanks
  24.  
  25.     Please read the chapters 1 and 2, first.  The remaining chapters will
  26. be useful when you want to use this converter.
  27.  
  28.  
  29. 1. What is "ish file converter"
  30.  
  31.     Ish file converter is one of the tools that enable to send/receive
  32. files including non printable characters (for example, executable programmes
  33. and graphical data) using an e-mail system or a bulletin board system (bbs)
  34. that can not accept binary data in communications.
  35.  
  36.     As executable programmes or graphical data have non printable control
  37. codes normally, you can't send/receive files using an e-mail or a bbs easily.
  38. You are able to send/receive these files using protocol communications such as
  39. xmodem, ymodem, zmodem or kermit, or converting them into text files that
  40. include only printable codes.  Ish file converter is a file conversion tool
  41. for sending/receiving data in communications.
  42.  
  43.     You can send/receive programmes easily using ish file converter in most
  44. personal computers communications networks.  The characteristics of ish file
  45. converter are shown follows.
  46.  
  47. (1) Highest reliability
  48.  
  49.     As using CRCs (cycle redundancy checks) for error detection, errors are
  50. detected almost perfectly when transfer errors occur.  In this case, when error
  51. rate is lower (two line errors or less in 62 or 72 lines), ish file converter
  52. corrects errors perfectly and restore files.  When error rate is higher, ish
  53. file converter report errors and delete files that can't be restored,
  54. automatically.  By this mechanism, you can free from trouble when received
  55. programmes are not run correctly --- miss transferred or bugs ?
  56.  
  57. (2) Easy operation to restore files
  58.  
  59.     Operations for restoring files are very simple.  First, you read all
  60. e-mails or boards with logging using your favorite terminal software.  Then,
  61. type
  62.  
  63. A>ish LogFilename(s)
  64.  
  65. and all files in LogFile(s) are restored.  That's all.  Although LogFile(s)
  66. include all texts you read, ish file converter ignore texts that are not parts
  67. of target files automatically and you need not erase these texts.
  68.  
  69. (3) Divide a file into multiple volumes
  70.  
  71.     When you want to send a large file, its converted file would exceed the
  72. limitation of an e-mail or bbs in bytes.  In this case, as you should divide it
  73. into multiple volumes, ish file converter can divide a file into upto 250
  74. multiple volumes.  Moreover, when restoring divided files, ish file converter
  75. maintains the sequence of divided files automatically even if volumes are in
  76. poor order or other files are in the middle of sequence of volumes in your
  77. log files.
  78.  
  79. (4) Useful facilities
  80.  
  81.     Ish file converter has many useful facilities that are easy to use for
  82. both beginners and experts.  For example, a file name and a line number can be
  83. written (a title can be written) in each converted file that is useful to
  84. download, you can restore files in the different disks or directories accouding
  85. to target operating systems, a capacity in bytes to be required for
  86. storing/restoring a file is displayed if disk free space is short, time stamps
  87. of files to be restored are corrected for your country.
  88.  
  89. (5) High speed
  90.  
  91.     Ish file converter is written in assembly language and is very faster.
  92.  
  93.  
  94.     Ish file converter is a software that is copyrighted by Masachika
  95. Ishizuka and can be used and distributed freely of charge.  More details are
  96. described in the chapter 11.
  97.  
  98.  
  99. 2. Quick reference to use ish file converter (restore files)
  100.  
  101.     First, put ish.com and ish.opt into a currect directory (or into a
  102. pathed directory) and set your timezone (see the chapter 7).
  103.  
  104.     Then, you download "ished" files into your disk.  Ished files are like
  105. below.
  106.  
  107. <<< ish.man for MS-DOS ( use ish ) [ 987 lines ] >>>
  108. !!SX!igR!2"DRo/f%_-C!C$oY9t5!&"H!Wa<\D!!!!?pu:TW)p!!!!!!!!!!!!!!!!!!!!!!!!rj-f
  109. !!SX!igR!2"DRo/f%_-C!C$oY9t5!&"H!Wa<\D!!!!?pu:TW)p!!!!!!!!!!!!!!!!!!!!!!!!rj-f
  110. !!SX!igR!2"DRo/f%_-C!C$oY9t5!&"H!Wa<\D!!!!?pu:TW)p!!!!!!!!!!!!!!!!!!!!!!!!rj-f
  111. "WC$<IphmLEM5SW]F3J2c+Xxuu0N'dB2={3AU~&'Du!v9t7n>'\0qYQ8+2mD"i:7Uc-BYZ+3ko0VD>
  112. $S9<*lYmw=0NeOjt:ximI!Q7+2'q[Cl?&XFwEw*wieu6eojtaEK7'}KWQ($t:,&fHFVs@gF8"[=wvF
  113.  
  114.     Finally, type
  115.  
  116. A>ish LogFilename(s)
  117.  
  118. to restore all MS-DOS files and OS independent files in LogFile(s). Or, type
  119.  
  120. A>ish LogFilename(s) /q
  121.  
  122. to restore all files (not only MS-DOS files and OS independent files but also
  123. ant other OSs' files) in LogFile(s) with question.  You can answer y (yes), n
  124. (no), r (restore all files) or q (quit ish file converter).
  125.  
  126.     More details are described in the chapter 3.
  127.  
  128.  
  129. 3. Usage of ish file converter
  130.  
  131. (1) How to restore files (from downloaded ished files)
  132.  
  133.     The following shows how to restore files.  ([A] means A is optional. 
  134. {A|B} means either A or B is selectable.)
  135.  
  136. A>ish [LogFilename(s)] [{/r|/q}] [/@ [tag]] [/m [path]] [/c [path]] [/9 [path]]
  137.       [/u [path]] [/ma [path]] [/? [path]] [/* [path]] [/nv] [/kp] [/it] [/qu]
  138.       [/so] [/lf]
  139.  
  140.     LogFilename(s) are files that include ished files.  If you specify no
  141. Logfilenames, ish file converter read from the standard input.  In this case,
  142. the standard input must be redirected other than a console.  Ish file converter
  143. Ver. 2.03 can't read from a console.  (If you force to read standard input, you
  144. must use other utilities like the cat.  A>cat | ish is one possible operation.)
  145.  
  146.     All switches are described in the chapter 4.
  147.  
  148.     Files are usually restored in your disk with original filenames and
  149. time stamps.  When the same filenames are already exist but these are not
  150. identical from the files to restore, filename extensions are renamed to 000,
  151. 001, ..., 999.  When you restore multiple volumes (see the chapter 6),
  152. temporary files with filename extension #00, #01, ..., #99 are created, then
  153. renamed to original names and delete temporary files after all volumes are
  154. restored.  A temporary file is a little bit larger than its original file
  155. because the temporary file includes control information to restore.  (Ish file
  156. converter Ver. 2.03 create temporary files 260 bytes larger than their original
  157. files.)
  158.  
  159.     You can redirect the standard output.  In this case, restored files are
  160. treated as printable text files, and input filenames and restored filenames are
  161. put into before restored files.  So you can't redirect the standard output when
  162. binary files are restored.  If you want to redirect the standard output to the
  163. console (con), specify the switch /so.
  164.  
  165. (2) How to store files (to upload)
  166.  
  167.     The following showns how to store files (create ished files). ([A]
  168. means A is optional.  {A|B} means either A or B is selectable.  ... means a
  169. repetition of any times.)
  170.  
  171. A>ish Filename(s) [/s[{7|8|s|n}]] [/@ [tag]] [{/m|/c|/9|/u|/ma|/?|/*} [path]]
  172.       [{/n|/e}] [/t [number]] [/mv [number]] [/p char [char ...]] [/nv] [/so]
  173.  
  174.     Filename(s) are files that are in the disks.  When storing files, you
  175. can't omit Filename(s) nor redirect the standard input.
  176.  
  177.     When storing files, you must specify correctly what OS (operating
  178. system) is target, or huge number of people who downloaded your files are
  179. troubled.
  180.  
  181.     All switches are described in the chapter 4.
  182.  
  183.     Ished files are stored in your disk renamed with filename extensions
  184. ish (single volume) or i01, i02, ..., i99, ia0, ia1, ..., ia9, ib0, ib1, ...,
  185. io9, ip0 (multiple volumes).  If the same filename is exist, the file is not
  186. stored.
  187.  
  188.     You can redirect the standard output.  If you want to redirect the
  189. tandard output to the console (con), specify the switch /so.
  190.  
  191. (3) Examples of redirection
  192.  
  193.     The following examples show how useful to redirect.
  194.  
  195. Example 1:
  196.  
  197.     A>ish a:logfile.lzh /s /mv 1000 /so
  198.  
  199.     You can check numbers of divided volumes and total lines easily.  This
  200. example is useful to adjust a value like a switch /mv number.  If you checked
  201. all values, you can stop ish file converter by pressing ^C.  If you finished
  202. the adjustment of values, rerun ish file converter without the switch /so and
  203. create an ished file.
  204.  
  205. Example 2:
  206.  
  207.     If your communication software can be sent files through the standard
  208. output directly, you need not create ished files before sending.  For example,
  209. the japanese popular communication software named 'termy' can
  210.  
  211. A>termy
  212. :t !ish Filename(s) /s
  213.  
  214. to upload Filename(s) with converting.
  215.  
  216. Example 3:
  217.  
  218.     A>ish a:*.* /ss /m | ish /m d:\backup
  219.  
  220.     This example shows to backup all files in the currect directory on the
  221. disk a: to d:\backup.  You must take care of disk free space for a temporary
  222. file to pipe.
  223.     As ish file converter checks duplicated files when restoring, you can
  224. avoid overwriting the existing files or duplicating the same files.
  225.  
  226.  
  227. 4. Switch summary
  228.  
  229. (1) Specify the restoring mode (/r, /q)
  230.  
  231.     These two switches specify to restore files.
  232.  
  233.   /r    (Restore)
  234.        All files in input files are restored.  If the same files are
  235.     already exist, verify files (single volume) or skip files (multiple
  236.     volumes).
  237.        /r is default when not specifying the storing nor restoring mode.
  238.  
  239.   /q    (restore with Question)
  240.        Each file is asked to restore or not.
  241.        Prompt is Restore ? (y/n/r/q) or Restore ? (y/n/r/q/!), and your
  242.     answer is y, n, r, q or ! as below.
  243.  
  244.     y (yes)
  245.        Restore this file.
  246.  
  247.     n (no)
  248.        Skip this file.
  249.  
  250.     r (restore)
  251.        Restore this file and all the following files.
  252.  
  253.     q (quit)
  254.        quit ish file converter and return to the MS-DOS shell.
  255.  
  256.     ! (shell escape)
  257.        Invoke the MS-DOS shell.  It is available only when the following
  258.       conditions are all met.
  259.       (a) The dos version is 3.0 or upper.
  260.       (b) The environ variable COMSPEC is setted correctly.
  261.       (c) The available memory is enough to invoke child shell.
  262.       (d) Both of the standard input and the standard output are not
  263.           redirected.
  264.        To return ish file converter, terminate the child shell.
  265.       (If the shell is command.com, type exit.)
  266.  
  267.        As the interaction of restoring or not is performed through the
  268.     standard error, if the standard error is redirected, this switch can
  269.     not be specified.
  270.  
  271. (2) Specify the storing mode (/s, /s7, /s8, /sn, /ss, /o, /o8, /os)
  272.  
  273.     These eight switches specify to store files.  The switches /o, /o8 and
  274. /os are not used normally because these switches are supplied only for the
  275. compatibilities of older ish file converters.
  276.  
  277.     The formats of ished files (ish formats) are four types, now.  These
  278. are the 7 bit format, the 8 bit format, the non-kana format and the shift JIS
  279. format.  If you use 7 bit communications, you should use the 7 bit format, or
  280. you fail to transfer files or transfer efficiency is poor because of forcing
  281. to keep the transparency of 8 bit data (perhaps, ^N (shift out) and ^O (shift
  282. in) are added).  If you can use 8 bit communications, you can use the 8 bit
  283. format, the non-kana format or the shift JIS format.
  284.  
  285.     The 7 bit format includes characters from 0x20 to 0x7e.
  286.  
  287.     The 8 bit format includes characters from 0x20 to 0x7e and from 0xa1
  288. to 0xdf.
  289.  
  290.     The non-kana format and the shift JIS format include characters from
  291. 0x20 to 0x7e and from 0x81 to 0xfe.
  292.  
  293.     And all formats include 0x0a (LF) and 0x0d (CR).  (And 0x1b (ESC) and
  294. other characters would be included for titles.)
  295.  
  296.     The 7 bit format converts 13 bits source data to 16 bits ished data.
  297.  
  298.     The 8 bit format and the non-kana format convert 7 bits source data to
  299. 8 bits ished data.
  300.  
  301.     The shift JIS format converts 15bits source data to 16 bits ished data.
  302.  
  303.     The three types of format for 8 bit communications are supplied because
  304. Japanese communications networks are typically classified these three types.
  305.  
  306.     When restoring files, you need not think what formats are used.  Ish
  307. file converter identify the formats and restores files automatically.
  308.  
  309.   /s    (Store)
  310.        The same as /s7.
  311.  
  312.   /s7    (Store the 7 bit format)
  313.        Store 7 bit format files.
  314.     (Sometimes, this format is called the JIS 7 format.)
  315.  
  316.   /s8    (Store the 8 bit format)
  317.        Store 8 bit format files.
  318.     (Sometimes, this format is called the JIS 8 format.)
  319.  
  320.   /sn    (Store the Non-kana format)
  321.        Store non-kana format files.
  322.     (Sometimes, this format is called the shift JIS (non-kana) format.)
  323.  
  324.   /ss    (Store the Shift jis format)
  325.        Store shift JIS format files.
  326.  
  327.   /o    (store the Old format)
  328.        Store old format files.
  329.     (This switch enables to keep the compatibility of older ish file
  330.     converters Ver. 1.01 or before.)
  331.  
  332.   /o8    (store the Old 8 bit format)
  333.        Store old 8 bit format files.
  334.     (This switch enables to keep the compatibility of older ish file
  335.     converters Ver. 1.xx.)
  336.  
  337.   /os    (store the Old Shift jis format)
  338.        Store old shift JIS format files.
  339.     (This switch enables to keep the compatibility of older ish file
  340.     converters Ver. 1.xx.)
  341.  
  342. (3) Specify the target operating system (/m, /u, /ma, /c, /9, /?, /*)
  343.  
  344.     These seven switches specify the target operation system(s) to store or
  345. restore.  You can specify only one OS when storing and many OSs when restoring.
  346.  
  347.     Each switch can specifies the path to store or restore.  If you omit
  348. the path, currect path is assumed.
  349.  
  350.   /m    (Msdos)
  351.        MS-DOS.
  352.     /m is default for storing or restoring.
  353.  
  354.   /u    (Unix)
  355.        unix.
  356.  
  357.   /ma    (MAc)
  358.        Mac.
  359.  
  360.   /c    (Cp/m)
  361.        CP/M.
  362.  
  363.   /9    (OS-9)
  364.        OS-9.
  365.  
  366.   /?    (other)
  367.        other OSs.
  368.  
  369.   /*    (all)
  370.        all OSs.
  371.        This switch means that this file is common for all OSs.
  372.     /* is default for restoring.
  373.  
  374.     And if you specify the switch /q and no switches for OSs, all switches
  375. of /m, /u, /ma, /c, /9, /? and /* are assumed.
  376.  
  377. (4) Specify the tag that identifys switches to be used (/@)
  378.  
  379.     To reduce efforts to specify command line switches, you can specify the
  380. combinations of switches in the file called "option file".
  381.  
  382.     Many combinations of switches can be written in an option file.  It is
  383. identfied by the identifier called "tag" that which combination will be used.
  384.  
  385.     More details are described in the chapter 5.
  386.  
  387.   /@    (tag)
  388.        You can specify a tag followed by the switch /@.  If you don't
  389.     specify the /@ tag, ish file converter assumes that the tag of
  390.     "default", "defaults" or "defaultr" is specified. (See the chapter 5.)
  391.     You can specify the /@ but no tags to disable refering to the default
  392.     tags.
  393.  
  394.        Ish file converter identifys that letters of a tag are capitals or
  395.     not.
  396.  
  397. (5) Specify other switches to store (/mv, /t, /p, /n, /e)
  398.  
  399.     These five switches can be specified to store.
  400.  
  401.   /mv    (Multi Volume format)
  402.        Specify to enable making multiple volume format ished files.  (See
  403.     the chapter 6.)
  404.        The maximun number of lines for each divided volume is specified
  405.     followed by the switch /mv.  Too small number of lines makes too many
  406.     volumes.  The maximum number of volumes for each file is 250.
  407.        As each number of lines is adjusted (reduced) automatically not to
  408.     waste spaces in bytes, it is not a bug that the number of lines in each
  409.     file is    not equal to the number specified.
  410.        If the number of lines specified is enough to store a single volume,
  411.     ish file converter ignores the switch /mv and create a single volume.
  412.  
  413.   /t    (Title)
  414.        Specify to write titles in ished files.
  415.        The number of lines in which a title is written again can be
  416.     specified followed by the switch /t.
  417.        The /t 0 has special meaning that specifys not to write titles.
  418.        The /t 1 or not to specify the switch /t is qeual to the /t 50.
  419.  
  420.   /p    (Prefix)
  421.        In some e-mail systems or bbss, a certain character on the head of
  422.     lines has a spacial meaning.  The switch /p enables not to locate
  423.     characters specified on the head of lines by inserting another
  424.     character.
  425.        Characters not on the head of lines are specified followed by the
  426.     switch /p.
  427.        For example, '/p !@abc' specifys that the characters of !, @, a, b
  428.     and c are not on the head of lines.
  429.        Another way to specify characters is hexadecimal value followed by
  430.     a backslash (\).  For example, '/p ab c\5c\7c \2f \20 def' specifys
  431.     that the characters of a, b, c, d, e, f, /, \, | and space are not on
  432.     the head.  (This example says that spaces among characters are igonored
  433.     and if you want specify the space character, you should specify \20.)
  434.  
  435.   /n    (Non escape sequence)
  436.        Specify not to use escape sequence for titles.
  437.        /n is default.
  438.  
  439.   /e    (Escape sequence)
  440.        Specify to use escape sequence of change colors for titles.
  441.  
  442. (6) Specify the other switches to restore (/it, /lf, /kp, /qu)
  443.  
  444.     These four switches can be specified to restore.
  445.  
  446.   /it    (Ignore Time stamps)
  447.        Specify to ignore time stamps.
  448.        If this switch is not specified, the same files but time stamps are
  449.     not identical are all restored.
  450.  
  451.   /lf    (ignore LFs and crs)
  452.        Specify to ignore LFs and CRs in ished files to restore.
  453.        As LFs and CRs are used for line delimiters, this switch is not
  454.     preferable to restore normal ished files.  Only when you can't restore
  455.     ished files, this switch would help you to restore files.
  456.        If files are restored with the switch /lf, the reliability of these
  457.     files are still good regardless above notice.
  458.        This switch makes slow down to restore files.
  459.  
  460.   /kp    (KeeP files)
  461.        Specify to keep files not to restore successfully.  If you don't
  462.     specify this switch, all files not to be restored successfully are
  463.     erased automatically.
  464.  
  465.   /qu    (QUick)
  466.        Specify to reduce displaying messages to be faster.
  467.  
  468. (7) Specify the other switches to store or restore (/nv, /so)
  469.  
  470.     These two switches can be specified to store or restore.
  471.  
  472.   /nv    (Not V30)
  473.        Specify that your CPU is not NEC V30 or fully compatibles.
  474.        Ish file converter checks the kind of CPUs.  If your CPU is one of
  475.     the Intel i8086, i8088, i80186, i80286, i386, i486 or fully
  476.     compatibles, or the NEC V20, V30, V40, V50 or fully compatibles, ish
  477.     file converter can identify automatically and you need not to specify
  478.     this switch.  If your CPU is another and ish file converter is not
  479.     running without this switch, you should specify this switch.
  480.  
  481.   /so    (Standard Output)
  482.        Specify the output to the standard output.
  483.        If you want to redirect the standard output to some file or device
  484.     other than the console, you need not specify this switch.
  485.  
  486.  
  487. 5. About an option file
  488.  
  489.     To reduce efforts of specifying command line switches, you can specify
  490. the combinations of switches in the file called an 'option file'.  It also
  491. enables that too many switches that are too long for a command line are
  492. specified.
  493.  
  494.     To use an option file, you set the option file's full path name to the
  495. environ variable 'ishopt'.  For example, you have the option file called
  496. a:\usr\bin\ish.opt, type
  497.  
  498. A>set ishopt=a:\usr\bin\ish.opt
  499.  
  500. (If you don't set ishopt, ish file converter assumes that the option file
  501. ish.opt exists the same directory of ish.com (MS-DOS 3.00 or upper), or the
  502. current directory (MS-DOS 2.xx).)
  503.  
  504. (1) How to write the option file
  505.  
  506.     An option file is consist of tags, switches and comments.
  507.  
  508.   tags
  509.        Many combinations of switches can be written in an option file.
  510.     It is identfied by the identifier called a 'tag' that which combination
  511.     is used.
  512.        Tags are the head of lines.  Unless other tags are appeared or the
  513.     end of the option file is encountered, each tag is effective.
  514.        Tags are made of alphabets, numeric figures, symbols (except colon)
  515.     and kanji (Chinese characters) and a colon(:) is followed by each tag.
  516.        Tags are not beginning at the #.  Letters are identified if capitals
  517.     or not.
  518.        The duplicate tags are not checked.  If you define tags duplicated,
  519.     ish file converter refers only to the first tag.
  520.        The following three tags are used for default tags.  If these
  521.     default tags are not found, errors are not occured.
  522.  
  523.     default:
  524.              This tag is referred when you don't specify the mode of
  525.           storing (/s, /s7, /s8, /sn, /ss, /o, /o8 nor /os), restoring
  526.           (/r nor /q) nor the switch /@.
  527.  
  528.     defaultr:
  529.              This tag is referred when you specify the restoring mode
  530.           (/r or /q) but don't specify the switch /@.
  531.  
  532.     defaults:
  533.              This tag is referred when you specify the storing mode
  534.           (/s, /s7, /s8, /sn, /ss, /o, /o8 or /os) but don't specify
  535.           the switch /@.
  536.  
  537.   switches
  538.        All switches (see the chapter 4.) except the /@ are available.
  539.     It is possible that you can write switches in the same line followed by
  540.     the tag or in many lines.  If you write switches in many lines, the
  541.     head of each line is space or tab because it is not to be confused a
  542.     next tag.
  543.        Although the number of switches in a tag is not limitted, the
  544.     duplication or the inconsistency of switches causes an error.
  545.  
  546.   comments
  547.        You can write comments in the option file.  The lines beginning with
  548.     # are ignored as comments by ish file converter.
  549.  
  550.     The following example shows how to write the option file.
  551.  
  552. # default tag
  553. default:
  554.     /nv
  555.  
  556. # defaults tag
  557. defaults:
  558.     /s7 /t 100
  559.     /m a:\upload
  560.  
  561. # defaultr tag
  562. defaultr:
  563.     /m  a:\download\msdos
  564.     /c  a:\download\cpm
  565.     /u  a:\download\unix
  566.     /ma a:\download\mac
  567.     /9  a:\download\os9
  568.     /?  a:\download\other
  569.     /*  a:\download\all
  570.  
  571. # pcs upload for msdos
  572. pu:    /ss /t 100
  573.     /m a:\upload
  574.  
  575. # multiple volume for msdos
  576. mv:    /ss /t 100
  577.     /m a:\upload
  578. #    each volume is limitted within 800 lines.
  579.     /mv 800
  580.  
  581. # pcs download
  582. pd:    /r  /qu
  583.     /m  a:\download\msdos
  584.     /c  a:\download\cpm
  585.     /u  a:\download\unix
  586.     /ma a:\download\mac
  587.     /9  a:\download\os9
  588.     /?  a:\download\other
  589.     /*  a:\download\all
  590.  
  591. (2) How to specify the tag
  592.  
  593.     You can specify a tag as shown below.
  594.  
  595. A>ish Filename(s) /@ tag
  596.  
  597.     You can specify only a tag at once.
  598.     If you don't want to refer to the default tags (default, defaultr nor
  599. defaults), you specify another tag or the /@ without tags.
  600.  
  601.     You may specify a tag with colon nor not.
  602.     You should take care that letters are identified if capitals or not.
  603.  
  604.     You may specify a tag with other command line switches.  In this case,
  605. you should take care of no duplication nor inconsistency of switches.
  606.  
  607.  
  608. 6. About a multiple volume format
  609.  
  610.     One merit of using ish file converter Ver. 2.03 is supporting the
  611. multiple volume format.
  612.  
  613.     If you want to send a too large file but you can't send so a large
  614. e-mail nor a large text for a bulletin board because of system limitation, the
  615. multiple volume facility is very useful.  And moreover, if you can send a huge
  616. file, it would be better for you to send divided volumes because if
  617. transmission errors occur and you resend a divided small volumes instead of a
  618. huge file.
  619.  
  620.     In the multiple volume format, each file is divided multiple ished
  621. volumes within the specified lines.  You only upload these all volumes in any
  622. sequence.
  623.  
  624.     You can download all volumes in any sequence to restore.  That is all.
  625. Finally, type
  626.  
  627. A>ish LogFilename(s)
  628.  
  629.     If you don't download any volumes, you can't restore files.  To search
  630. what volumes are not downloaded yet, type
  631.  
  632. A>disp# TemporaryFilename(s)
  633.  
  634.     That reports the status of TemporaryFile(s).
  635.  
  636.  
  637. 7. Set the timezone
  638.  
  639.     Ish file converter Ver. 2.03 can adjust time stamps of restoring files
  640. between communications with the difference in time.  To use this facility, you
  641. and your partner should set the timezone.  (If you or your partner don't set
  642. the timezone, time stamp adjustment is not performed.  As the older version of
  643. ish file converter (Ver. 1.xx) doesn't have this facility, if you or your
  644. partner use the older version, time stamp adjustment is not performed.)
  645.  
  646.     To set the timezone, the following two ways are provided.
  647.  
  648. (1) Set the environment variable 'tz'
  649.  
  650.     The environment valiable 'tz' can be set as shown below.
  651.  
  652. A>set tz=std[{+|-}]h[h][dst[any]]
  653.  
  654.     The first three letters 'std' are timezone name.  Ish file converter
  655. ignores the content of the name but expects three letters to get a following
  656. number.
  657.  
  658.     The next one to three signed numeric letters are the difference in
  659. time.  The sing is the '+' or '-', and the '+' can be omitted.  The number is
  660. one or two digits.  The number is set in hours between your country time and
  661. UTC.  (UTC is almost equal to GMT.)  The sign '+' means your country time is
  662. later than UTC.
  663.  
  664.     Although you can specify the name of summer time 'dst' and then any
  665. letters, ish file converter ifnores all these letters.
  666.  
  667.     This way to set the 'tz' is easy but ish file converter ignores summer
  668. time, don't use unless you country has not summer time.
  669.  
  670.     For example, Japan has no summer time and nine hous ahead of UTC, then
  671.  
  672. A>set tz=JST-9
  673.  
  674. (2) Set the timezone file
  675.  
  676.     This way can set summer time.  You create a timezone file and set the
  677. timezone filename to the environment valiable 'ishtz'.  For example, you create
  678. the timezone file named 'a:\usr\bin\timezone.tbl', type
  679.  
  680. A>set ishtz=a:\usr\bin\timezone.tbl
  681.  
  682.     If you set both the 'tz' and 'ishtz', the 'ishtz' is used in
  683. preference to the 'tz'.  In this case, if corresponding date and time is not in
  684. the timezone file, then the 'tz' is used.
  685.  
  686.     If the 'tz' is not set and corresponding date and time is not in the
  687. timezone file, the difference in time is assumed to 0.
  688.  
  689.     The timezone file is made of more than or equal to zero lines as
  690. follows.
  691.  
  692. yyyy-mm-dd-hh:mm:ss    YYYY-MM-DD-HH:MM:SS    [{+|-}]hh:mm:ss
  693.  
  694.     From yyyy-mm-dd-hh:mm:ss (country time) to YYYY-MM-DD-HH:MM:SS
  695. (country time) is different [{+|-}]hh:mm:ss from UTC in time.  The sign '+'
  696. means your country time is later than UTC.
  697.  
  698.     These lines need not to write in sequence.  Ish file converter searches
  699. date and time from the upper lines, so you can write the most referred lines
  700. upper in order to reduce overhead time.
  701.  
  702.     You must exactly write the symbols ('-' and ':') as shown above.  Each
  703. line has to begin at the head of line.  The 'yyyy' and 'YYYY' must be exactly
  704. four digits and the other number must be exactly two digits.  For example, You
  705. can't write 90-10-01-00:00:00 or -9:00:00 instead of 1990-10-01-00:00:00 or
  706. -09:00:00.  The delimiter of items is a space or a tab.
  707.  
  708.     The following line is a example that is equivalent to set tz=JST-9.
  709.  
  710. 1980-01-01-00:00:00    2099-12-31-23:59:59    -09:00:00
  711.  
  712.  
  713. 8. Caution when aborting ish file converter
  714.  
  715.     If you want to abort ish file converter, you must press ^C (or stop
  716. or break key).  Other operations such as turning the power off or pressing the
  717. reset button will create half restoring files or destroy temporary files.
  718.  
  719.  
  720. 9. Message summary
  721.  
  722.     The most messages are shown below in alphabetic order.
  723.  
  724.  
  725. 　Aborted by the user.
  726.     (You pressed ^C and aborted.)
  727.  
  728. 　Can't execute shell.
  729.     (Probably, your memory is short, the 'comspec' is invalid, and so on.)
  730.  
  731. 　can't renamed to 'xxx'
  732.     (Probably, the same filename is already existing.)
  733.  
  734.   Can't restore break condition.
  735.     (Probably, due to bugs in ish file converter or other softwares.)
  736.  
  737.   Can't take input from a console.
  738.     (Redirect the standard input not to the console, or specify filenames.)
  739.  
  740.   Can't take input from the stdin.
  741.     (Specify filenames.)
  742.  
  743.   compare file read error
  744.     (Probably, your disk is destroyed, or due to bugs in ish file converter
  745.     or other softwares.)
  746.  
  747. 　CRC-16 and CRC-32 are not available.
  748.     (An ished file is stored by older ish file converter.)
  749.  
  750.   CRC-16 error detect.
  751.     (An ished file or temporary file are destroyed.)
  752.  
  753. 　CRC-16 is OK.
  754.  
  755. 　CRC-16 and CRC-32 are OK.
  756.  
  757.   CRC-32 error detect.
  758.     (An ished file or temporary file is destroyed.)
  759.  
  760. 　CRC-32 is OK.
  761.  
  762. 　CRC checking
  763.  
  764. 　crc error detect
  765.     (An ished file is destroyed.)
  766.  
  767.   disk full
  768.     (You keep more than or equal to disk free spaces displayed and
  769.     reexecute.)
  770.  
  771. 　error detect
  772.     (You try to download again.  Or you check your modem and terminal.
  773.     Or uploaded files are destroyed.)
  774.  
  775. 　file already exist
  776.     (Rename to the existing file.)
  777.  
  778. 　file creation error
  779.     (Probably, your disk is write protected, or your disk is destroyed.)
  780.  
  781.   file division number over 250.
  782.     (Enlarge the number of /mv.)
  783.  
  784. 　file name error
  785.     (Check filenames.)
  786.  
  787. 　file not found
  788.     (Check filenames.)
  789.  
  790. 　file open error
  791.     (Probably, disk is destroyed.)
  792.  
  793. 　file restored successfully.
  794.  
  795. 　file write error
  796.     (Probably, disk is full or your disk is destroyed.)
  797.  
  798.   file 'xxx' already exist
  799.     (Rename or remove the existing file.)
  800.  
  801.   file 'xxx' not found
  802.     (Check filenames.)
  803.  
  804. 　files are the same.
  805.  
  806. 　xx file(s) stored.
  807.  
  808. 　xx file(s)/ yy volume(s) restored.
  809.  
  810. 　illegal switch(es)
  811.     (Probably, undefined switches are specified, or illegal combination of
  812.     switches.  Check also in the option file.)
  813.  
  814. 　input file read error
  815.     (Probably, your disk is destroyed.)
  816.  
  817. 　ish abnormal end.
  818.  
  819. 　ish file is created.
  820.  
  821.   memory allocation error
  822.     (Probably, due to bugs in ish file converter or other softwares.)
  823.  
  824.   /mv number too short.
  825.     (Enlarge the number of /mv.)
  826.  
  827.   no files converted.
  828.  
  829.   option file 'xxx' open error.
  830.     (Check the environment variable 'ishopt' and the option file.)
  831.  
  832.   option file or tz file read error.
  833.     (Check the option file and the timezone file.)
  834.  
  835. 　output file is deleted.
  836.  
  837. 　output file is kept
  838. 　because /kp was specified.
  839.  
  840. 　Output to the stdout.
  841.  
  842. 　path 'xxx' not found
  843.     (Check the directory.  If not exist, make the directory.)
  844.  
  845. 　prefix character 'x' is ahead of 'yy'
  846.  
  847.   prefix must be one of the ' `~{}ow'.
  848.     (You specify too many characters in the switch /p.  Remove unnecessary
  849.     characters.)
  850.  
  851.   /q is not available
  852.   when the standard error handle is not assigned to a console.
  853.     (Stop to redirect the standard error or don't specify the switch /q.)
  854.  
  855. 　renamed to 'xxx'
  856.  
  857. 　source file is empty
  858.  
  859.   tag 'xxx' not found.
  860.     (Check the tag.)
  861.  
  862. 　This is for other OSs
  863.  
  864.   too long option file.
  865.     (Pack the contents within the tag specified.)
  866.  
  867.   too long option filename.
  868.     (The length of option filename shall be 64 characters or less include
  869.     its pathname.)
  870.  
  871.   too long shell name.
  872.     (The length of shell name shall be 64 characters or less include its
  873.     pathname.)
  874.  
  875. 　too short memories
  876.  
  877.   TZ error.
  878.     (Check the environment valiable 'tz')
  879.  
  880.   tz file data error.
  881.     (check the timezone file format.)
  882.  
  883.   tz file open error.
  884.     (Check the environment variable 'ishtz' and the timezone file.)
  885.  
  886. 　Unacceptable format
  887.     (Use the newest version of ish file converter.)
  888.  
  889.   Unexpected standard handle error.
  890.     (In abnormal MS-DOS status.  Please restart the MS-DOS.)
  891.  
  892. 　volume restored successfully.
  893.  
  894.   ^Z is detected
  895.     (This error will occur when redirecting the standard output to a device
  896.     and a restoring file is not a text file.)
  897.  
  898.  
  899. 10. Examples to use
  900.  
  901. (1) Restore all MS-DOS files to the a:\log\msdos from *.log on current
  902.     directory.
  903.  
  904. A>ish *.log /m a:\log\msdos
  905. ish file converter for MS-DOS  Ver. 2.03
  906. Copyright (C) 1986, 1987, 1989, 1990   by  M. Ishizuka
  907. [ restore <new> (m) ]
  908.          ^ This showed ms-dos.
  909. 90-03-23.log:                    <- The name of logged file.
  910. [843] blib092.lzh(m) : (46/46) o        <- An ished file named blib092s
  911.    file restored successfully.               .lzh for ms-dos was found in
  912. [921] blib092s.lzh(m) : (126/126) oo           843 lines and it was 
  913.    file restored successfully.               restored. The length of body
  914. [1198] taka_m01.lzh(m) : (42/42) o           was 46 lines.
  915.    file restored successfully.
  916. [2301] china2.lzh(m) > china2.000: (85/85) oo    <- Restored and renamed to
  917.    file restored successfully.               china2.000 because the same
  918.                            name file existed.
  919. [3180] squares.npb(*) : This is for other OSs ... skip this file.
  920. [3520] sw_doc.lzh(m) : (59/59) o        ^ Skipped because this was not
  921.    file restored successfully.            for ms-dos.
  922. [3601] snowfms.lzh(m) ? snowfms.lzh: (77/77) oo <- The same file existed and
  923.    files are the same.                　 compared to verify.
  924. [3761] xneko.taz(m) : (460/460) ooo1o2o        <- ooo1o2o meant that one line
  925.    file restored successfully.               error in the fourth block
  926. [4919] cinit.lzh(m) : (44/44) o               and two line error in the
  927.    file restored successfully.               sixth block were occured.
  928. [5469] snowfmex.lzh(m) : (93/93) oo           (Each block had 62, 66 or 72
  929.    file restored successfully.               lines.)
  930. [6326] mm.lzh(m) : (52/52) o
  931.    file restored successfully.
  932. [13010] b.txt(m) : (117/325) ox            <- Aborted at the 117th line
  933.                            of body.
  934. error detect ... abort this file ( more than or equal to 3 errors / block )
  935.    output file is deleted.
  936.    error lines => [13113]->(I)   [13120]->(Q)   [13128]->(a)
  937.                        ^`    ^ Errors occured at the
  938.    9 file(s)/ 0 volume(s) restored.       |      13111th, 13120th and 13128th
  939.                        |      lines of body.
  940.                  ( ) showed the heading characters of its line.
  941.  
  942. (Note) About the lines to display
  943.    The number of lines displayed in [ ] was counted from the top of this file.
  944.    The number such as (3/3) was the relative line number within the restoring
  945. file and this was counted only the lines of 'body'.
  946.    The 'body' is the part of contents, not include titles, comments nor
  947. headers, of an ished file.
  948.    For example, the following ished file has 8 lines totally, the first line is
  949. a comment, the following three lines are headers, and the last line is a title.
  950. So, the body is 3 lines.  (Lines from 5th to 7th are the body.)
  951.  
  952. <<< test.txt for MS-DOS ( use ish ) [ 8 lines ] >>>
  953. !!C*!!gR!2"DRo?5Gm@^!C$o^2;K!'"HEI]<\XCC}aFz9k2a*Y!!!!!!!!!!!!!!!!!!!!!!!!9Q>4
  954. !!C*!!gR!2"DRo?5Gm@^!C$o^2;K!'"HEI]<\XCC}aFz9k2a*Y!!!!!!!!!!!!!!!!!!!!!!!!9Q>4
  955. !!C*!!gR!2"DRo?5Gm@^!C$o^2;K!'"HEI]<\XCC}aFz9k2a*Y!!!!!!!!!!!!!!!!!!!!!!!!9Q>4
  956. "*;OT:-Q"{C\>SlQb!P{)k6g]h*y9|%w@^iLf/[P"A5B=K!!!!!!!!!!!!!!!!!!!!!!!!!!!!-:)N
  957. a[Z6NX-)|jc%4^5xJ?OHy'$qB}zf96{Rk_7w=d[,}Fq@5g!!!!!!!!!!!!!!!!!!!!!!!!!!!!m0xj
  958. c_B3\vWg"U!BPLLs)EZ6P'QvB|<VG'@PQO}7)A_'|a5MsPzk8MvZGBexre,w{fnNr@{4m'}W{u9LLH
  959. --- test.txt (8/8) ---
  960.  
  961.  
  962. (2) Store all *.lzh files on the current directory.  The format is the shift
  963.     JIS and the target OS is ms-dos.
  964.  
  965. A>ish *.lzh /ss /m
  966. ish file converter for MS-DOS  Ver. 2.03
  967. Copyright (C) 1986, 1987, 1989, 1990   by  M. Ishizuka
  968. [ store <shift JIS format> (m) ]
  969. test1.lzh: ish file is created.
  970. test2.lzh: ish file is created.
  971.  
  972.    2 file(s) stored.
  973.  
  974.     The test1.ish and test2.ish ware created on the current directory.
  975.  
  976.  
  977. (3) Store all *.lzh files on the current directory.  The format is the 7 bit,
  978.     the target OS is unix, and enables the multiple volume facility.  Each
  979.     volume has less than or equal to 100 lines.
  980.  
  981. A>ish *.lzh /s7 /mv 100 /u
  982. ish file converter for MS-DOS  Ver. 2.03
  983. Copyright (C) 1986, 1987, 1989, 1990   by  M. Ishizuka
  984. [ store <shift JIS format> (u) ]
  985. test1.lzh: ish file is created.
  986. test2.lzh: file 'test2.ish' already exist ... skip this file.
  987.  
  988.    1 file(s) stored.
  989.  
  990.     The test1.lzh was converted to the multiple volumes named test1.i01,
  991. test1.i02, and so on.  On the other hand, the test2.lzh was a small file and
  992. its ished file was less than 100 lines.  So, the test2.lzh would be converted
  993. to the test2.ish, but the test2.ish was already existing and could not be
  994. converted.
  995.  
  996.  
  997. (4) Restore all *.i02 and *.i* files on the current directory onto the drive b.
  998.     The target OSs are ms-dos and unix.
  999.  
  1000. A>ish *.i02 *.i* /r /m b: /u b:
  1001. ish file converter for MS-DOS  Ver. 2.03
  1002. Copyright (C) 1986, 1987, 1989, 1990   by  M. Ishizuka
  1003. [ restore <new> (m,u) ]
  1004. test1.i02:
  1005. [3] test1.lzh(u)<2/3> > test1.#00: (72/72) o
  1006.    volume restored successfully.
  1007. test1.ish:
  1008. [2] test1.lzh(m) : (203/203) ooo
  1009.    file restored successfully.
  1010. test2.ish:
  1011. [2] test2.lzh(m) : (20/20) o
  1012.    file restored successfully.
  1013. test1.i01:
  1014. [3] test1.lzh(u)<1/3> > test1.#00: (72/72) o
  1015.    volume restored successfully.
  1016. test1.i02:
  1017. [3] test1.lzh(u)<2/3> : file 'test1.#00' is the same ... skip this file.
  1018. test1.i03:
  1019. [3] test1.lzh(u)<3/3> > test1.#00: (59/59) o
  1020.    CRC-16 and CRC-32 are OK.
  1021.    renamed to 'test1.000'
  1022.    file restored successfully.
  1023.  
  1024.    3 file(s)/ 2 volume(s) restored.
  1025.  
  1026.     The test1.#00 was a temporary file and was renamed automatically after
  1027. all volumes ware restored.
  1028.  
  1029.  
  1030. (5) Only check to restore without real restoring action.
  1031.  
  1032. A>ish *.i* /m /u /r >nul
  1033. ish file converter for MS-DOS  Ver. 2.03
  1034. Copyright (C) 1986, 1987, 1989, 1990   by  M. Ishizuka
  1035. [ restore <new> (m,*) ]
  1036. Output to the stdout.
  1037. test1.ish:
  1038. [2] test1.lzh(m) : (203/203) ooo
  1039.    file restored successfully.
  1040. test2.ish:
  1041. [2] test2.lzh(m) : (20/20) o
  1042.    file restored successfully.
  1043. test1.i01:
  1044. [3] test1.lzh(u)<1/3> : (72/72) o
  1045.    volume restored successfully.
  1046. test1.i02:
  1047. [3] test1.lzh(u)<2/3> : (72/72) o
  1048.    volume restored successfully.
  1049. test1.i03:
  1050. [3] test1.lzh(u)<3/3> : (59/59) o
  1051.    volume restored successfully.
  1052.  
  1053.    2 file(s)/ 3 volume(s) restored.
  1054.  
  1055.     The all files could be restored.
  1056.  
  1057.  
  1058. 11. Copyrights and permission
  1059.  
  1060.     Ish file converter is permitted to use anybody.  And it is permitted to
  1061. distribute every bulletin board free of charge without any changes.  The
  1062. reports or mail are not necessary to use or distribute above conditions.
  1063.  
  1064.     If you distribute in the media, you can receive actual expenses for
  1065. media and post.
  1066.  
  1067.     If you distribute ish file converter, please distribute at least the
  1068. following together.  I'm grad for you to distribute all files include sources.
  1069.  
  1070. (1) The executable files (ish.com and disp#.com).
  1071. (2) This document (eish.man).
  1072.  
  1073.     It is permitted to change for your personal use.  But if you want to
  1074. distribute changed programme, please give me e-mail.
  1075.  
  1076.     The development and support are available only in ASCII-NET PCS in
  1077. Japan.
  1078.  
  1079.     Selling this programme without my permission is inhibbited.
  1080.  
  1081.     I can't give a guarantee about this programme.
  1082.  
  1083.     All rights of this programme are reserved by Masachika Ishizuka.
  1084.  
  1085.     If you send me e-mail, send to
  1086.  
  1087.     PCS (ASCII-NET in Japan)    pcs20210
  1088.     JUNET in Japan            ishizuka@kyo-sr.ntt.jp
  1089.  
  1090.  
  1091. 12. Special thanks
  1092.  
  1093.     Ish file converter has been developed on many advices.  Thank all
  1094. people advised to me.
  1095.     Special thanks for pcs29357 (kmori) in ASCII-NET PCS in Japan who gave
  1096. me many useful information about the timezone.
  1097.  
  1098.                 1990/8/5   Masachika Ishizuka in Japanese
  1099.                 1990/8/26  Translated in English by M. Ishizuka
  1100.                 1990/11/3  Updated by M. Ishizuka
  1101.